home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / comm / gold22.zip / GOLD.DOC < prev    next >
Text File  |  1992-02-16  |  6KB  |  152 lines
  1.          GOLD - simulate GOLD key with NUM LOCK - version 2.1
  2.  
  3.                            Bob Eager
  4.  
  5.                          February 1992
  6.  
  7. Overview
  8. --------
  9. GOLD is a simple TSR (Terminate and Stay Resident) program which is
  10. primarily intended to make it easier to use Kermit as an emulator for a
  11. VTnnn series terminal (where nnn is at least 100) with an enhanced
  12. keyboard (the one with separate numeric pad and cursor keys). 
  13.  
  14. What GOLD does is make the NUM LOCK key transmit the code for the F1
  15. key; this is normally mapped by Kermit to the VTnnn GOLD key.  This
  16. makes it possible (by using the SET KEY command of Kermit) to make the
  17. keypad look almost exactly the same as a VTnnn keypad (the long + key is
  18. the only exception; that is two keys on the real terminal). 
  19.  
  20. Using GOLD
  21. ----------
  22. To use GOLD, simply place the GOLD.COM file into a directory on the
  23. normal program path, then type the command:
  24.  
  25.               GOLD
  26.  
  27. This will activate the program, and NUM LOCK will cease to work as NUM
  28. LOCK and will instead operate the same as the F1 key.  This may not
  29. always be convenient, so it is possible to turn off the effect by
  30. typing:
  31.  
  32.               GOLD OFF
  33.  
  34. and later to turn it on again by typing:
  35.  
  36.               GOLD ON
  37.  
  38. The current GOLD state may be displayed by typing:
  39.  
  40.               GOLD
  41.  
  42. (after the first call, this is the only effect if the command is used
  43. without parameters).  The program can be set to an initial OFF state by
  44. calling it the first time with the OFF parameter if required.  Later
  45. calls operate with the initially installed copy of the program, which
  46. cannot be unloaded (it is, however, very small; only 432 or 496 bytes of
  47. memory are required, depending on the operating mode (see below)). 
  48.  
  49. It is possible to get the original NUM LOCK function without turning
  50. GOLD OFF.  This is useful if you are inside an application and realise
  51. NUM LOCK has been left ON accidentally, and GOLD is also ON.  The key
  52. combination SHIFT and NUM LOCK will toggle the NUM LOCK state each time
  53. it is used (just as NUM LOCK does on its own when GOLD is OFF). 
  54.  
  55. It is also possible to turn GOLD on and off without calling it as a
  56. command.  The key combination ALT and NUM LOCK will turn GOLD off if it
  57. is on, and on if it is off.  Note that ALT and NUM LOCK normally
  58. operates exactly as a normal NUM LOCK, so no functionality is lost when
  59. GOLD is loaded. 
  60.  
  61. If you are using DOS 5, GOLD may be loaded using the LOADHIGH command; this
  62. saves space if upper memory space is available.
  63.  
  64. Compatibility
  65. -------------
  66. Some machines may not contain BIOS support for this program; in such
  67. cases, GOLD automatically uses an alternate operating mode (direct
  68. interception of keyboard interrupts) which will work on true compatible
  69. machines.  However, this method uses slightly more memory (496 byte
  70. against 432 bytes) and requires a high degree of machine compatibility. 
  71.  
  72. Problems have been reported where GOLD appears to have no effect, even
  73. if each of the particular modes is forced.  In many cases this appears
  74. to be due to a version of the KEYB (or KEYBxx) command used for
  75. reconfiguring non-US keyboards; it steals the keyboard interrupt vector
  76. and fails to honour the keyboard intercept request from GOLD.  The
  77. solution is generally to use an earlier version of the KEYB program (or
  78. one of the country specific versions such as KEYBUK) or to use a KEYB
  79. program from a PC-DOS system; these appear not to have the problem. 
  80.  
  81. Version 2.1 of GOLD has been changed to use a different multiplex ID
  82. value, which I am told makes it work OK with KEYB in cases where it
  83. would not otherwise do so (thanks to David Denholm).  In any case, the
  84. MPID is easily altered without rebuilding GOLD (see below). 
  85.  
  86. Configuration
  87. -------------
  88. The program uses the INT 2FH multiplex interrupt to install itself; it
  89. uses a multiplex ID of 0DCH.  This may be changed if it clashes with
  90. other TSR programs.  The key to which NUM LOCK is mapped may also be
  91. changed.  It is also possible to force GOLD to use a particular
  92. operating mode (BIOS keyboard intercept, or direct keyboard interrupt
  93. intercept). 
  94.  
  95. Alteration of the above items is obvious on examination of the program
  96. source code.  If you do not have MASM, it is easy to patch the program
  97. since the relevant values are stored in easy to find places - offsets
  98. 102H, 103H and 104H. 
  99.  
  100. GOLD has been tested on PC-DOS 3.0, 3.1, 3.3, 5.0, MS-DOS 3.2, 3.3 and 5.0,
  101. and in the DOS mode session of IBM OS/2 versions 1.2 and 1.3.  Tests were
  102. performed on an IBM PC/XT compatible (PC-DOS and MS-DOS all versions),
  103. an IBM PC/XT (PC-DOS version 3.3) and an IBM PS/2 Model 80-111 (PC-DOS
  104. versions 3.3 and 5.0, and OS/2 versions 1.2 and 1.3). 
  105.  
  106. Files included
  107. --------------
  108. This package should consist of the following files.  Please distribute
  109. all of these files if you pass the package on. 
  110.  
  111.     GOLD.COM    - executable program for GOLD
  112.     GOLD.DOC    - documentation (this file)
  113.     GOLD.ASM    - MASM source code
  114.     MAKE.BAT    - batch file to build GOLD
  115.     KEYPAD.TAK    - Kermit TAKE file to define keyboard for DEC terminal
  116.  
  117. Acknowledgement
  118. ---------------
  119. Thanks to all those, all over the world, who have contacted me with
  120. suggestions for improvements to GOLD.  There are too many to mention
  121. individually, and many people made the same or similar suggestions. 
  122.  
  123. Contact
  124. -------
  125. Please send any comments or suggestions to me, Bob Eager.
  126.  
  127. rde@ukc.ac.uk (USENET) (preferred over ibmpcug)
  128. rde@ibmpcug.co.uk (USENET)
  129. 100016,2770   (CompuServe)
  130. +44 227 764000 ext 7589 (Telephone)
  131.  
  132. ==============================================================================
  133.  
  134. Update history
  135. --------------
  136.  
  137. 2.2    - added some additional safety code to the installation check
  138.  
  139. 2.1    - changed default multiplex ID value to 09FH to fix problems with
  140.       some versions of KEYB
  141.  
  142. 2.0    - added SHIFT and NUM LOCK facility to provide original NUM LOCK
  143.       capability
  144.     - added ALT and NUM LOCK facility to change GOLD status directly
  145.     - fixed interrupt intercept incompatibility with some clone BIOSes
  146.     - fixed non-detection of BIOS intercept support in some cases
  147.     - added code to use direct keyboard interrupt handler if BIOS
  148.       interrupt intercept facility not available
  149.  
  150. 1.0    - initial program version
  151.  
  152.